home *** CD-ROM | disk | FTP | other *** search
/ AGA Toolkit '97 / The AGA Toolkit '97.iso / programming / gui / mui2.2 / developer / extclasses / mcc_busy / autodocs / mcc_busy.doc
Encoding:
Text File  |  1996-09-07  |  1.7 KB  |  89 lines
  1. TABLE OF CONTENTS
  2.  
  3. Busy.mcc/Busy.mcc
  4. Busy.mcc/MUIM_Busy_Move
  5. Busy.mcc/MUIA_Busy_Color1
  6. Busy.mcc/MUIA_Busy_Color2
  7. Busy.mcc/MUIA_Busy_Position
  8. Busy.mcc/MUIA_Busy_Size
  9. Busy.mcc/Busy.mcc
  10.  
  11.     BusyClass provides a graphical line of two repeated rectangles in
  12.     different colors. This line can be moved, which should indicate a
  13.     busy situation, it represents some work in the behind.
  14.  
  15.     The size, the colors of the rectangles and the position of the
  16.     first box could be controlled.
  17.  
  18.     The bar hasn't a frame, nor a background, so you ought to define
  19.     them like other areas, e.g.:
  20.  
  21.         by_info = BusyObject,
  22.             GaugeFrame,
  23.             MUIA_Background, MUII_BACKGROUND,
  24.             End,
  25.  
  26. Busy.mcc/MUIM_Busy_Move
  27.  
  28.     NAME
  29.     MUIM_Busy_Move
  30.  
  31.     SYNOPSIS
  32.     DoMethod(obj, MUIM_Busy_Move, );
  33.  
  34.     FUNCTION
  35.     Let the busy object scroll two pixels to the right.
  36.  
  37.     EXAMPLE
  38.     while (gn)
  39.     {
  40.         gn = get_next_amun_group();
  41.         DoMethod(by_info, MUIM_Busy_Move, );
  42.     }
  43.  
  44.     SEE ALSO
  45. Busy.mcc/MUIA_Busy_Color1
  46.  
  47.     NAME
  48.     MUIA_Busy_Color1 -- [ISG], ULONG
  49.  
  50.     FUNCTION
  51.     The color of the first rectangle.
  52.  
  53.     SEE ALSO
  54.     MUIA_Busy_Color2
  55. Busy.mcc/MUIA_Busy_Color2
  56.  
  57.     NAME
  58.     MUIA_Busy_Color2 -- [ISG], ULONG
  59.  
  60.     FUNCTION
  61.     The color of the second rectangle.
  62.  
  63.     SEE ALSO
  64.     MUIA_Busy_Color1
  65. Busy.mcc/MUIA_Busy_Position
  66.  
  67.     NAME
  68.     MUIA_Busy_Position -- [ISG], ULONG
  69.  
  70.     FUNCTION
  71.     This is the position of the first rectangle of color 1.
  72.  
  73.     Check out, that the position could only be in range of 0 to
  74.     (2*MUIA_Busy_Size-1).
  75.  
  76.     SEE ALSO
  77.     MUIA_Busy_Size
  78. Busy.mcc/MUIA_Busy_Size
  79.  
  80.     NAME
  81.     MUIA_Busy_Size -- [ISG], ULONG
  82.  
  83.     FUNCTION
  84.     Indicates the width in pixel of one rectangle.  Valid range is
  85.     from 4 upto 64.
  86.  
  87.     SEE ALSO
  88.     MUIA_Busy_Position
  89.